package com.stark.wechat.service.menu.model;

import lombok.Getter;

/**
 * 枚举按钮类型
 *
 * @author <a href="mengbin@eastsoft.com.cn">Ben</a>
 * @version 1.0.0
 * @see <a href="https://developers.weixin.qq.com/doc/service/api/custommenu/api_createcustommenu.html#_4-%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9">自定义菜单 / 创建自定义菜单</a>
 * @since 2025/8/6
 */
@Getter
public enum ButtonType {

    /**
     * 点击推事件：用户点击click类型按钮后，微信服务器会通过消息接口推送消息类型为event的结构给开发者（参考消息接口指南），并且带上按钮中开发者填写的key值，开发者可以通过自定义的key值与用户进行交互；
     */
    click(ClickButton.class),
    /**
     * 跳转URL：用户点击view类型按钮后，微信客户端将会打开开发者在按钮中填写的网页URL，可与网页授权获取用户基本信息接口结合，获得用户基本信息。
     */
    view(ViewButton.class),
    /**
     * 图文消息展示素材按钮
     */
    view_limited(ViewLimitedButton.class),
    /**
     * 扫码推事件：用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后显示扫描结果（如果是URL，将进入URL），且会将扫码的结果传给开发者，开发者可以下发消息。
     */
    scancode_push(ScancodePushButton.class),
    /**
     * 扫码推事件且弹出“消息接收中”提示框：用户点击按钮后，微信客户端将调起扫一扫工具，完成扫码操作后，将扫码的结果传给开发者，同时收起扫一扫工具，然后弹出“消息接收中”提示框，随后可能会收到开发者下发的消息。
     */
    scancode_waitmsg(ScancodeWaitmsgButton.class),
    /**
     * 弹出系统拍照发图：用户点击按钮后，微信客户端将调起系统相机，完成拍照操作后，会将拍摄的相片发送给开发者，并推送事件给开发者，同时收起系统相机，随后可能会收到开发者下发的消息。
     */
    pic_sysphoto(PicSysphotoButton.class),
    /**
     * 弹出拍照或者相册发图：用户点击按钮后，微信客户端将弹出选择器供用户选择“拍照”或者“从手机相册选择”。用户选择后即走其他两种流程。
     */
    pic_photo_or_album(PicPhotoOrAlbumButton.class),
    /**
     * 弹出微信相册发图器：用户点击按钮后，微信客户端将调起微信相册，完成选择操作后，将选择的相片发送给开发者的服务器，并推送事件给开发者，同时收起相册，随后可能会收到开发者下发的消息。
     */
    pic_weixin(PicWeixinButton.class),
    /**
     * 弹出地理位置选择器：用户点击按钮后，微信客户端将调起地理位置选择工具，完成选择操作后，将选择的地理位置发送给开发者的服务器，同时收起位置选择工具，随后可能会收到开发者下发的消息。
     */
    location_select(LocationSelectButton.class),
    /**
     * 下发消息（除文本消息）：用户点击media_id类型按钮后，微信服务器会将开发者填写的永久素材id对应的素材下发给用户，永久素材类型可以是图片、音频、视频。请注意：永久素材id必须是在“素材管理/新增永久素材”接口上传后获得的合法id。
     */
    media_id(MediaIdButton.class),
    /**
     * 下发图文消息：用户点击 article_id 类型按钮后，微信客户端将会以卡片形式，下发开发者在按钮中填写的图文消息
     */
    article_id(ArticleIdButton.class),
    /**
     * 图文消息展示草稿
     */
    article_view_limited(ArticleViewLimitedButton.class);

    private final Class<? extends Button> buttonClass;

    ButtonType(Class<? extends Button> buttonClass) {
        this.buttonClass = buttonClass;
    }

}
